GetProductsForOrgGuid
Overview
The GetProductsForOrgGuid operation retrieves the universe of products for organizations based on the organization included in the request.
This operation returns a collection of pair data based on the organization provided. The list of products returned is based on the user’s role:
- Standard User (does not have ‘System Administrator’ application role): returns the products for the organization requested and products for all organizations up the hierarchy tree structure.
- System Administration User (has ‘System Administrator’ application role): returns the products for organization requested and products for all organizations up and down the hierarchy tree structure.
| Operation | ListDocuments |
|---|---|
| Style | document |
| Operation | Request-response. The endpoint receives a message, and sends a correlated message. |
| SOAP Action | SOAP Action |
| Input | IIntegrationService_GetProductsForOrgGuid_InputMessage (soap:body, use = literal) parameters type GetProductsForOrgGuidRequest |
| Output | IIntegrationService_GetProductsForOrgGuid_OutputMessage (soap:body, use = literal) parameters type GetProductsForOrgGuidResponse |
Request Message
The operation input is GetProductsForOrgGuidRequest. The request requires a GetProductsForOrgGuidRequest object containing user and password as parameters on the input.
| Parameter | Type | Constraints | Description |
|---|---|---|---|
| request | GetProductsForOrgGuidRequest | Required | The input message for the GetProductsForOrgGuid operation used to request a list of OPPSA products for organization requested. |
Response Element
The operation output is GetProductsForOrgGuidResponse. The response returns a GetProductsForOrgGuidResponse object containing status information for the request.
| Element | Type | Description |
|---|---|---|
| GetProductsForOrgGuidResponse | GetProductsForOrgGuidResponse | The output message for the GetProductsForOrgGuid operation used to return the details of the request. |
GetProductsForOrgGuid Example Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:int="http://integrationservice.oppsa.wk">
<soapenv:Header/>
<soapenv:Body>
<tem:GetProductsForOrgGuid>
<!--Optional:-->
<tem:userName>user1</tem:userName>
<!--Optional:-->
<tem:password>Password111!</tem:password>
<!--Optional:-->
<tem:organizationGuid>d2c12e6e845a9685b88f56f2c7dede11</tem:organizationGuid>
</tem:GetProductsForOrgGuid>
</soapenv:Body>
</soapenv:Envelope>
GetProductsForOrgGuid Example Response
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Header>
<ActivityId CorrelationId="12224821-9588-43a4-9063-503be0ad90ce" xmlns="http://schemas.microsoft.com/2004/09/ServiceModel/Diagnostics">84edb407-8b2e-46bc-ac45-b1f0fd11b7fa</ActivityId>
</s:Header>
<s:Body>
<GetProductsForOrgGuidResponse xmlns="http://integrationservice.oppsa.wk">
<GetProductsForOrgGuidResult xmlns:a="http://schemas.datacontract.org/2004/07/WoltersKluwerFS.OPPSA.Web.DataContracts">
<a:ProductInfo>
<a:ProductName>Product AAA</a:ProductName>
<a:ProductType>Checking Account</a:ProductType>
</a:ProductInfo>
<a:ProductInfo>
<a:ProductName>Product BBB</a:ProductName>
<a:ProductType>Savings Account</a:ProductType>
</a:ProductInfo>
</GetProductsForOrgGuidResult>
</GetProductsForOrgGuidResponse>
</s:Body>
</s:Envelope>